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

نوع مورد واجهة برمجة التطبيقات بالنسبة إلى تقرير الاستخدام، تكون القيمة 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

نوع مورد واجهة برمجة التطبيقات بالنسبة إلى تقرير الاستخدام، تكون القيمة 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 = "كائن". ملاحظة: اسم التقرير المخصّص للجهات الخارجية هو "العناصر" بدلاً من "الكائنات".

entity.type

string

النتائج فقط. نوع العنصر القيمة هي user.

الطُرق

get

يسترجع تقريرًا يمثّل مجموعة من المواقع والإحصاءات لحساب عميل معيّن.