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

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

النتائج فقط. عنوان البريد الإلكتروني للمستخدِم. تكون ذات صلة فقط إذا كان الكيان لكيان = "USER"
entity.profileId

string

النتائج فقط. معرّف الملف الشخصي غير القابل للتغيير للمستخدم في Google Workspace
entity.entityId

string

النتائج فقط. مفتاح الكائن. تكون ذات صلة فقط إذا كان كيان الكيان = "OBJECT" ملاحظة: الاسم الخارجي للتقرير هو "الكيانات" بدلاً من "الكائنات".
entity.type

string

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

الطُرق

get

 لاسترداد التقرير الذي يعد مجموعة من المواقع والإحصاءات لحساب عميل معين.