REST Resource: projects.locations.reportConfigs

משאב: ReportConfig

הודעה שמתארת את אובייקט ReportConfig. ‫ReportConfig היא ההגדרה שמשמשת ליצירת דוחות מלאי. מידע על הגדרת שדות שונים זמין במאמר יצירת הגדרה של דוח מלאי.

ייצוג ב-JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "frequencyOptions": {
    object (FrequencyOptions)
  },
  "labels": {
    string: string,
    ...
  },
  "displayName": string,

  // Union field report_format can be only one of the following:
  "csvOptions": {
    object (CSVOptions)
  },
  "parquetOptions": {
    object (ParquetOptions)
  }
  // End of list of possible types for union field report_format.

  // Union field report_kind can be only one of the following:
  "objectMetadataReportOptions": {
    object (ObjectMetadataReportOptions)
  }
  // End of list of possible types for union field report_kind.
}
שדות
name

string

מזהה. שם המשאב.

פורמט: projects/{projectId}/locations/{location}/reportConfigs/{report-config-id}
createTime

string (Timestamp format)

פלט בלבד. השעה בפורמט UTC שבה נוצרה ההגדרה של דוח המלאי. השדה הזה מאוכלס אוטומטית.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

פלט בלבד. השעה בשעון UTC שבה עודכנה ההגדרה של דוח המלאי. השדה הזה מאוכלס אוטומטית.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
frequencyOptions

object (FrequencyOptions)

התדירות של הפקת דוח המלאי.
labels

map (key: string, value: string)

תוויות כצמדי מפתח/ערך

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

השם המוצג שסופק על ידי המשתמש יכול להיות ריק, והוא מוגבל ל-256 תווים. אפשר לערוך אותו.
שדה איחוד report_format. הפורמט שבו נוצר דוח המלאי. הערך report_format יכול להיות רק אחד מהבאים:
csvOptions

object (CSVOptions)

אפשרויות לדוחות בפורמט CSV.
parquetOptions

object (ParquetOptions)

אפשרויות לדוחות בפורמט Parquet.
שדה איחוד report_kind. אפשרויות הגדרה של תוכן דוח המלאי. הערך report_kind יכול להיות רק אחד מהבאים:
objectMetadataReportOptions

object (ObjectMetadataReportOptions)

אפשרויות להכללת מטא-נתונים של אובייקטים בדוח מלאי.

FrequencyOptions

משאב FrequencyOptions

הגדרת התדירות ליצירת דוחות מלאי.

ייצוג ב-JSON 
{
  "frequency": enum (Frequency),
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
שדות
frequency

enum (Frequency)

התדירות שבה נוצרים דוחות מלאי.
startDate

object (Date)

התאריך בפורמט UTC שבו תרצו להתחיל להפיק דוחות מלאי. לדוגמה,{"day": 15, "month": 8, "year": 2022}.
endDate

object (Date)

התאריך בפורמט UTC שבו תרצו להפסיק את ההפקה של דוחות מלאי. לדוגמה,{"day": 15, "month": 8, "year": 2022}.

תדירות

התדירות שבה מופקים דוחות המלאי. הערכים האפשריים הם FREQUENCY_UNSPECIFIED, ‏ DAILY או WEEKLY.

טיפוסים בני מנייה (enum)
FREQUENCY_UNSPECIFIED לא צוין.
DAILY דוח המלאי מופק מדי יום.
WEEKLY דוח מלאי שטחי הפרסום נוצר מדי שבוע.

תאריך

מייצג תאריך מלא או חלקי ביומן, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שהם לא משמעותיים. התאריך הוא יחסי ללוח השנה הגרגוריאני. הערך הזה יכול לייצג את אחת מהאפשרויות הבאות:

  • תאריך מלא, עם ערכים שאינם אפס לשנה, לחודש וליום.
  • חודש ויום, עם שנה אפס (לדוגמה, יום נישואין).
  • שנה לבד, עם חודש אפס ויום אפס.
  • שנה וחודש, עם יום אפס (לדוגמה, תאריך התפוגה של כרטיס אשראי).

סוגים קשורים:

ייצוג ב-JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. הערך חייב להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום.
day

integer

היום בחודש. הערך חייב להיות בין 1 ל-31, והוא צריך להיות תקף לשנה ולחודש, או 0 כדי לציין רק שנה או שנה וחודש שבהם היום לא משמעותי.

CSVOptions

אפשרויות להגדרת דוחות מלאי בפורמט CSV.

ייצוג ב-JSON 
{
  "recordSeparator": string,
  "delimiter": string,
  "headerRequired": boolean
}
שדות
recordSeparator

string

תווים להפרדת רשומות ב-CSV.
delimiter

string

תווים מפרידים ב-CSV.
headerRequired

boolean

אם מוגדר, כולל שורת כותרת בדוח ה-CSV.

ParquetOptions

בסוג הזה אין שדות.

אפשרויות להגדרת דוחות מלאי בפורמט Parquet.

ObjectMetadataReportOptions

אפשרויות להכללת מטא-נתונים בדוח מלאי.

ייצוג ב-JSON 
{
  "metadataFields": [
    string
  ],

  // Union field filter can be only one of the following:
  "storageFilters": {
    object (CloudStorageFilters)
  }
  // End of list of possible types for union field filter.

  // Union field destination_options can be only one of the following:
  "storageDestinationOptions": {
    object (CloudStorageDestinationOptions)
  }
  // End of list of possible types for union field destination_options.
}
שדות
metadataFields[]

string

שדות המטא-נתונים שנכללים בדוח המלאי.
שדה איחוד filter. מסננים קטגוריות כדי ליצור דוחות מלאי ל-Cloud Storage. הערך filter יכול להיות רק אחד מהבאים:
storageFilters

object (CloudStorageFilters)

מסננים קטגוריות כדי ליצור דוחות מלאי ל-Cloud Storage.
שדה איחוד destination_options. אפשרויות לאחסון דוחות ב-Cloud Storage. הערך destination_options יכול להיות רק אחד מהבאים:
storageDestinationOptions

object (CloudStorageDestinationOptions)

אפשרויות לאחסון דוחות ב-Cloud Storage.

CloudStorageFilters

מסננים קטגוריות כדי ליצור דוחות מלאי ל-Cloud Storage.

ייצוג ב-JSON 
{
  "bucket": string
}
שדות
bucket

string

זה שינוי אופציונלי. הקטגוריה שעבורה מופק דוח המלאי.

CloudStorageDestinationOptions

אפשרויות לאחסון דוחות מלאי ב-Cloud Storage.

ייצוג ב-JSON 
{
  "bucket": string,
  "destinationPath": string
}
שדות
bucket

string

זה שינוי אופציונלי. קטגוריית היעד של דוחות המלאי.
destinationPath

string

נתיב היעד בתוך הקטגוריה שבה מאוחסנים דוחות המלאי.

Methods

create

 יצירת הגדרה חדשה של דוח מלאי בפרויקט נתון למיקום נתון.

delete

 מחיקת הגדרה קיימת של דוח מלאי בפרויקט נתון במיקום נתון.

get

 אחזור ההגדרה של דוח המלאי בפרויקט נתון עבור מיקום נתון.

list

 הצגת רשימה של הגדרות דוחות מלאי בפרויקט מסוים במיקום נתון.

patch

 עדכון של הגדרה קיימת של דוח מלאי בפרויקט נתון עבור מיקום נתון.