REST Resource: customerUsageReports

Zasób: UsageReports

Zapis JSON
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
Pola
kind

string

Typ zasobu interfejsu API. W przypadku raportu dotyczącego wykorzystania wartość wynosi admin#reports#usageReports.

etag

string

Tag ETag zasobu.

warnings[]

object

Ewentualne ostrzeżenia.

warnings[].code

string

Czytelny dla komputera kod lub typ ostrzeżenia. Wartość kodu ostrzeżenia to 200.

warnings[].message

string

Zrozumiałe dla człowieka komunikaty ostrzegawcze:

  • Ostrzeżenie o niedostępnych danych: dane z daty rrrr-mm-dd dla aplikacji „application name” nie jest dostępna.
  • Dostępne są częściowe dane. Ostrzeżenie: dane z dnia rrrr-mm-dd dla aplikacji „application name” nie jest teraz dostępny, spróbuj ponownie za kilka godzin.

warnings[].data[]

object

Pary klucz-wartość zawierające szczegółowe informacje o ostrzeżeniu.

warnings[].data[].key

string

Klucz powiązany z parą klucz-wartość w celu podania szczegółowych informacji o ostrzeżeniu.

warnings[].data[].value

string

Wartość powiązana z parą klucz-wartość, która zawiera szczegółowe informacje o ostrzeżeniu.

usageReports[]

object (UsageReport)

Różne rekordy parametrów aplikacji.

nextPageToken

string

Token do określenia następnej strony. Raport z wieloma stronami zawiera w odpowiedzi właściwość nextPageToken. W przypadku kolejnych żądań pobierających wszystkie strony raportu wpisz wartość nextPageToken w ciągu zapytania pageToken.

UsageReport

Szablon JSON raportu dotyczącego wykorzystania.

Zapis 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
  }
}
Pola
kind

string

Typ zasobu interfejsu API. W przypadku raportu dotyczącego wykorzystania wartość wynosi admin#reports#usageReport.

date

string

Tylko dane wyjściowe. Data żądania raportu.

parameters[]

object

Tylko dane wyjściowe. Pary wartości parametrów dla różnych aplikacji. Informacje o parametrach i wartościach raportu wykorzystania encji znajdziesz w dokumentacji parametrów wykorzystania encji.

parameters[].intValue

string (int64 format)

Tylko dane wyjściowe. Wartość parametru (liczba całkowita).

parameters[].name

string

Nazwa parametru. Nazwy parametrów w raporcie wykorzystania użytkowników znajdziesz w tym artykule.

parameters[].stringValue

string

Tylko dane wyjściowe. Wartość parametru w postaci ciągu znaków.

parameters[].datetimeValue

string

Sformatowana wartość parametru RFC 3339, na przykład 2010-10-28T10:26:35.000Z.

parameters[].boolValue

boolean

Tylko dane wyjściowe. Wartość logiczna parametru.

parameters[].msgValue[]

object (Struct format)

Tylko dane wyjściowe. Zagnieżdżona wartość komunikatu w parametrze.

etag

string

Tag ETag zasobu.

entity

object

Tylko dane wyjściowe. Informacje o typie elementu.

entity.customerId

string

Tylko dane wyjściowe. Niepowtarzalny identyfikator konta klienta.

entity.userEmail

string

Tylko dane wyjściowe. Adres e-mail użytkownika. Ma zastosowanie tylko wtedy, gdy entity.type = "UŻYTKOWNIK"

entity.profileId

string

Tylko dane wyjściowe. Stały identyfikator profilu Google Workspace użytkownika.

entity.entityId

string

Tylko dane wyjściowe. Klucz obiektu. Ma zastosowanie tylko wtedy, gdy entity.type = "OBJECT" Uwaga: nazwa raportu widoczna dla użytkowników zewnętrznych to „Elementy” a nie „Obiekty”.

entity.type

string

Tylko dane wyjściowe. Typ elementu. Wartość to user.

Metody

get

Pobiera raport będący zbiorem właściwości i statystyk konta określonego klienta.