Resource: UsageReports
| JSON representation |
|---|
{
"kind"
:
string
,
"etag"
:
string
,
"warnings"
:
[
{
"code"
:
string
,
"message"
:
string
,
"data"
:
[
{
"key"
:
string
,
"value"
:
string
}
]
}
]
,
"usageReports"
:
[
{
object (
|
kind
string
The type of API resource. For a usage report, the value is admin#reports#usageReports
.
etag
string
ETag of the resource.
warnings[]
object
Warnings, if any.
warnings[].code
string
Machine readable code or warning type. The warning code value is 200
.
warnings[].message
string
The human readable messages for a warning are:
- Data is not available warning - Sorry, data for date yyyy-mm-dd
for application "
application name" is not available. - Partial data is available warning - Data for date yyyy-mm-dd
for application "
application name" is not available right now, please try again after a few hours.
warnings[].data[]
object
Key-value pairs to give detailed information on the warning.
warnings[].data[].key
string
Key associated with a key-value pair to give detailed information on the warning.
warnings[].data[].value
string
Value associated with a key-value pair to give detailed information on the warning.
usageReports[]
object (
UsageReport
)
Various application parameter records.
nextPageToken
string
Token to specify next page. A report with multiple pages has a nextPageToken
property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken
value in the pageToken
query string.
UsageReport
JSON template for a usage report.
| JSON representation |
|---|
{ "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 } } |
| Fields | |
|---|---|
kind
|
The type of API resource. For a usage report, the value is |
date
|
Output only. The date of the report request. |
parameters[]
|
Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see the Entity Usage parameters reference . |
parameters[].intValue
|
Output only. Integer value of the parameter. |
parameters[].name
|
The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference . |
parameters[].stringValue
|
Output only. String value of the parameter. |
parameters[].datetimeValue
|
The RFC 3339
formatted value of the parameter, for example |
parameters[].boolValue
|
Output only. Boolean value of the parameter. |
parameters[].msgValue[]
|
Output only. Nested message value of the parameter. |
etag
|
ETag of the resource. |
entity
|
Output only. Information about the type of the item. |
entity.customerId
|
Output only. The unique identifier of the customer's account. |
entity.userEmail
|
Output only. The user's email address. Only relevant if entity.type = "USER" |
entity.profileId
|
Output only. The user's immutable Google Workspace profile identifier. |
entity.entityId
|
Output only. Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name of report is "Entities" rather than "Objects". |
entity.type
|
Output only. The type of item. The value is |
Methods |
|
|---|---|
|
Retrieves a report which is a collection of properties and statistics for a specific customer's account. |
