REST Resource: customerUsageReports

משאב: דוחות שימוש

ייצוג 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.

דוח שימוש

תבנית 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

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

entity.profileId

string

פלט בלבד. המזהה הקבוע של המשתמש ב-Google Workspace.

entity.entityId

string

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

entity.type

string

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

שיטות

get

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