REST Resource: projects.locations.reportConfigs.reportDetails

משאב: ReportDetail

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

ייצוג ב-JSON
{
  "name": string,
  "snapshotTime": string,
  "reportPathPrefix": string,
  "shardsCount": string,
  "status": {
    object (Status)
  },
  "labels": {
    string: string,
    ...
  },
  "targetDatetime": {
    object (DateTime)
  },
  "reportMetrics": {
    object (Metrics)
  }
}
שדות
name

string

שם המשאב. פורמט: projects/{projectNumber}/locations/{location}/reportConfigs/{report-config-id}/reportDetails/{report-detail-id}

snapshotTime

string (Timestamp format)

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

הפורמט הוא 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".

reportPathPrefix

string

הקידומת של שם האובייקט של כל רסיס בדוח. הוא כולל את הקידומת המלאה, חוץ מ-extension ו-shard_id. לדוגמה, אם הערך של destinationPath הוא {report-config-id}/dt={datetime}, אז שם האובייקט המפוצל הוא gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_5.csv והערך של השדה reportPathPrefix הוא gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_.

shardsCount

string (int64 format)

מספר הרסיסים הכולל שנוצרו עבור דוח המלאי.

status

object (Status)

הסטטוס של דוח המלאי.

labels

map (key: string, value: string)

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

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

targetDatetime

object (DateTime)

התאריך והשעה שבהם נוצר דוח המלאי. השדה הזה מאוכלס אוטומטית. החלק של השעה ב-targetDatetime הוא תמיד 0.

reportMetrics

object (Metrics)

מדדים של דוח המלאי.

DateTime

מייצג זמן אזרחי (או לעיתים זמן פיזי).

הסוג הזה יכול לייצג זמן אזרחי באחת מכמה דרכים אפשריות:

  • אם המאפיין utcOffset מוגדר והמאפיין timeZone לא מוגדר: שעה אזרחית ביום מסוים בלוח השנה עם קיזוז מסוים מ-UTC.
  • אם מגדירים את timeZone ולא מגדירים את utcOffset: שעה אזרחית ביום מסוים ביומן, באזור זמן מסוים.
  • אם לא מוגדרים timeZone או utcOffset: השעה האזרחית ביום מסוים ביומן, לפי השעון המקומי.

התאריך הוא יחסי ליומן הגרגוריאני הפרוֹלֶפטי.

אם השנה, החודש או היום הם 0, התאריך והשעה נחשבים כחסרי שנה, חודש או יום ספציפיים, בהתאמה.

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

הסוג הזה גמיש יותר ממה שחלק מהאפליקציות עשויות לרצות. חשוב לתעד את המגבלות של האפליקציה ולאמת אותן.

ייצוג ב-JSON
{
  "year": integer,
  "month": integer,
  "day": integer,
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer,

  // Union field time_offset can be only one of the following:
  "utcOffset": string,
  "timeZone": {
    object (TimeZone)
  }
  // End of list of possible types for union field time_offset.
}
שדות
year

integer

זה שינוי אופציונלי. השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 אם מציינים תאריך ושעה בלי שנה.

month

integer

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

day

integer

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

hours

integer

זה שינוי אופציונלי. שעות ביום בפורמט של 24 שעות. הערך צריך להיות בין 0 ל-23, ברירת המחדל היא 0 (חצות). יכול להיות ש-API יאפשר את הערך '24:00:00' בתרחישים כמו שעת הסגירה של העסק.

minutes

integer

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

seconds

integer

זה שינוי אופציונלי. רכיב השניות של השעה. בדרך כלל הערך צריך להיות בין 0 ל-59, וערך ברירת המחדל הוא 0. יכול להיות ש-API יאפשר את הערך 60 אם הוא מאפשר שניות מעוברות.

nanos

integer

זה שינוי אופציונלי. שברירי שניות בננו-שניות. הערך חייב להיות בין 0 ל-999,999,999. ברירת המחדל היא 0.

שדה איחוד time_offset. זה שינוי אופציונלי. מציינים את הסטייה משעון UTC או את אזור הזמן של התאריך והשעה. חשוב לבחור בקפידה ביניהן, כי יכול להיות שנתוני אזור הזמן ישתנו בעתיד (לדוגמה, מדינה משנה את תאריכי ההתחלה והסיום של שעון הקיץ, ותאריכי שעה ותאריך עתידיים בטווח המושפע כבר נשמרו). אם לא מציינים את אזור הזמן, המערכת מניחה שהתאריך והשעה הם לפי הזמן המקומי. הערך time_offset יכול להיות רק אחד מהבאים:
utcOffset

string (Duration format)

הפרש משעון UTC. הערך צריך להיות מספר שלם של שניות, בין ‎-18 שעות לבין ‎+18 שעות. לדוגמה, היסט מ-UTC של ‎-4:00 ייוצג כ-‎{ seconds: -14400 }.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".

timeZone

object (TimeZone)

אזור זמן.

אזור זמן

מייצג אזור זמן מתוך מסד הנתונים של אזורי הזמן של IANA.

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

string

אזור הזמן של מסד הנתונים של IANA. לדוגמה, America/New_York.

version

string

זה שינוי אופציונלי. מספר הגרסה של מסד הנתונים של אזורי הזמן של IANA. לדוגמה, '2019a'.

מדדים

מדדים שמשויכים לדוח שנוצר.

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

string (int64 format)

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

Methods

get

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

list

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