REST Resource: customerUsageReports

משאב: UsageReports

ייצוג ב-JSON 
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

סוג משאב ה-API. בדוח שימוש, הערך הוא admin#reports#usageReports.
etag

string

ה-ETag של המשאב.
warnings[]

object

אזהרות, אם יש כאלה.
warnings[].code

string

קוד קריא למחשב או סוג אזהרה. הערך של קוד האזהרה הוא 200.
warnings[].message

string

אלה ההודעות שקריאות לבני אדם לגבי אזהרה:

  • אזהרה על כך שהנתונים לא זמינים – לצערנו, אין נתונים עבור התאריך yyyy-mm-dd עבור האפליקציה 'application name'.
  • אזהרה: נתונים חלקיים זמינים – הנתונים של התאריך yyyy-mm-dd לא זמינים כרגע לאפליקציה 'application name'. יש לנסות שוב אחרי כמה שעות.

warnings[].data[]

object

צמדי מפתח/ערך שמספקים מידע מפורט על האזהרה.
warnings[].data[].key

string

מפתח שמשויך לצמד מפתח/ערך כדי לספק מידע מפורט על האזהרה.
warnings[].data[].value

string

הערך שמשויך לצמד מפתח/ערך כדי לספק מידע מפורט על האזהרה.
usageReports[]

object (UsageReport)

רשומות שונות של פרמטרים של אפליקציות.
nextPageToken

string

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

UsageReport

תבנית JSON לדוח שימוש.

ייצוג ב-JSON 
{
  "kind": string,
  "date": string,
  "parameters": [
    {
      "intValue": string,
      "name": string,
      "stringValue": string,
      "datetimeValue": string,
      "boolValue": boolean,
      "msgValue": [
        {
          object
        }
      ]
    }
  ],
  "etag": string,
  "entity": {
    "customerId": string,
    "userEmail": string,
    "profileId": string,
    "entityId": string,
    "type": string
  }
}
שדות
kind

string

סוג משאב ה-API. בדוח שימוש, הערך הוא admin#reports#usageReport.
date

string

פלט בלבד. התאריך שבו נשלחה בקשת הדוח.
parameters[]

object

פלט בלבד. זוגות של ערכי פרמטרים לאפליקציות שונות. למידע על הפרמטרים והערכים של דוח השימוש בישויות, ראו חומר עזר בנושא פרמטרים של שימוש בישויות.
parameters[].intValue

string (int64 format)

פלט בלבד. ערך המספר השלם של הפרמטר.
parameters[].name

string

שם הפרמטר. למידע על שמות הפרמטרים של דוח השימוש במשתמשים, עיינו בחומר העזר בנושא פרמטרים של שימוש במשתמשים.
parameters[].stringValue

string

פלט בלבד. ערך המחרוזת של הפרמטר.
parameters[].datetimeValue

string

הערך של הפרמטר בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z.
parameters[].boolValue

boolean

פלט בלבד. הערך הבוליאני של הפרמטר.
parameters[].msgValue[]

object (Struct format)

פלט בלבד. ערך ההודעה המוטמעת של הפרמטר.
etag

string

ה-ETag של המשאב.
entity

object

פלט בלבד. מידע על סוג הפריט.
entity.customerId

string

פלט בלבד. המזהה הייחודי של חשבון הלקוח.
entity.userEmail

string

פלט בלבד. זוהי כתובת האימייל של המשתמש. רלוונטי רק אם Entity.type = "USER"
entity.profileId

string

פלט בלבד. מזהה הפרופיל של המשתמש ב-Google Workspace, שלא ניתן לשינוי.
entity.entityId

string

פלט בלבד. מפתח אובייקט. רלוונטי רק אם entity.type = "OBJECT". הערה: השם של הדוח שמוצג לגורמים חיצוניים הוא 'ישויות' ולא 'אובייקטים'.
entity.type

string

פלט בלבד. סוג הפריט. הערך הוא user.

שיטות

get

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