fix: Update cursor animations to run infinitely for smoother transitions#288107
fix: Update cursor animations to run infinitely for smoother transitions#288107kiofaw wants to merge 3 commits intomicrosoft:mainfrom
Conversation
mohmmeed
left a comment
mohmmeed
left a comment
There was a problem hiding this comment.
{
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"basePath": "",
"ownerDomain": "google.com",
"ownerName": "Google",
"canonicalName": "reports",
"schemas": {
"Activities": {
"id": "Activities",
"description": "JSON template for a collection of activities.",
"type": "object",
"properties": {
"kind": {
"description": "The type of API resource. For an activity report, the value is reports#activities.",
"default": "admin#reports#activities",
"type": "string"
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"items": {
"description": "Each activity record in the response.",
"type": "array",
"items": {
"$ref": "Activity"
}
},
"nextPageToken": {
"description": "Token for retrieving the follow-on next page of the report. The nextPageToken value is used in the request's pageToken query string.",
"type": "string"
}
}
},
"Activity": {
"id": "Activity",
"description": "JSON template for the activity resource.",
"type": "object",
"properties": {
"kind": {
"description": "The type of API resource. For an activity report, the value is audit#activity.",
"default": "admin#reports#activity",
"type": "string"
},
"etag": {
"description": "ETag of the entry.",
"type": "string"
},
"ownerDomain": {
"description": "This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.",
"type": "string"
},
"ipAddress": {
"description": "IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.",
"type": "string"
},
"events": {
"description": "Activity events in the report.",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"description": "Type of event. The Google Workspace service or feature that an administrator changes is identified in the type property which identifies an event using the eventName property. For a full list of the API's type categories, see the list of event names for various applications above in applicationName.",
"type": "string"
},
"name": {
"description": "Name of the event. This is the specific name of the activity reported by the API. And each eventName is related to a specific Google Workspace service or feature which the API organizes into types of events. For eventName request parameters in general: - If no eventName is given, the report returns all possible instances of an eventName. - When you request an eventName, the API's response returns all activities which contain that eventName. For more information about eventName properties, see the list of event names for various applications above in applicationName.",
"type": "string"
},
"parameters": {
"description": "Parameter value pairs for various applications. For more information about eventName parameters, see the list of event names for various applications above in applicationName.",
"type": "array",
"items": {
"type": "object",
"properties": {
"messageValue": {
"description": "Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}]",
"type": "object",
"properties": {
"parameter": {
"description": "Parameter values",
"type": "array",
"items": {
"$ref": "NestedParameter"
}
}
}
},
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"value": {
"description": "String value of the parameter.",
"type": "string"
},
"multiValue": {
"description": "String values of the parameter.",
"type": "array",
"items": {
"type": "string"
}
},
"intValue": {
"description": "Integer value of the parameter.",
"type": "string",
"format": "int64"
},
"multiIntValue": {
"description": "Integer values of the parameter.",
"type": "array",
"items": {
"type": "string",
"format": "int64"
}
},
"boolValue": {
"description": "Boolean value of the parameter.",
"type": "boolean"
},
"multiMessageValue": {
"description": "List of messageValue objects.",
"type": "array",
"items": {
"type": "object",
"properties": {
"parameter": {
"description": "Parameter values",
"type": "array",
"items": {
"$ref": "NestedParameter"
}
}
}
}
}
}
}
},
"resourceIds": {
"description": "Resource ids associated with the event.",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"description": "Unique identifier for each activity record.",
"type": "object",
"properties": {
"time": {
"description": "Time of occurrence of the activity. This is in UNIX epoch time in seconds.",
"type": "string",
"format": "date-time"
},
"uniqueQualifier": {
"description": "Unique qualifier if multiple events have the same time.",
"type": "string",
"format": "int64"
},
"applicationName": {
"description": "Application name to which the event belongs. For possible values see the list of applications above in applicationName.",
"type": "string"
},
"customerId": {
"description": "The unique identifier for a Google Workspace account.",
"type": "string"
}
}
},
"actor": {
"description": "User doing the action.",
"type": "object",
"properties": {
"profileId": {
"description": "The unique Google Workspace profile ID of the actor. This value might be absent if the actor is not a Google Workspace user, or may be the number 105250506097979753968 which acts as a placeholder ID.",
"type": "string"
},
"email": {
"description": "The primary email address of the actor. May be absent if there is no email address associated with the actor.",
"type": "string"
},
"callerType": {
"description": "The type of actor.",
"type": "string"
},
"key": {
"description": "Only present when callerType is KEY. Can be the consumer_key of the requestor for OAuth 2LO API requests or an identifier for robot accounts.",
"type": "string"
},
"applicationInfo": {
"description": "Details of the application that was the actor for the activity.",
"type": "object",
"properties": {
"oauthClientId": {
"description": "OAuth client id of the third party application used to perform the action.",
"type": "string"
},
"applicationName": {
"description": "Name of the application used to perform the action.",
"type": "string"
},
"impersonation": {
"description": "Whether the application was impersonating a user.",
"type": "boolean"
}
}
}
}
},
"networkInfo": {
"description": "Network information of the user doing the action.",
"$ref": "ActivityNetworkInfo"
},
"resourceDetails": {
"description": "Details of the resource on which the action was performed.",
"type": "array",
"items": {
"$ref": "ResourceDetails"
}
}
}
},
"NestedParameter": {
"id": "NestedParameter",
"description": "JSON template for a parameter used in various reports.",
"type": "object",
"properties": {
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"value": {
"description": "String value of the parameter.",
"type": "string"
},
"multiValue": {
"description": "Multiple string values of the parameter.",
"type": "array",
"items": {
"type": "string"
}
},
"intValue": {
"description": "Integer value of the parameter.",
"type": "string",
"format": "int64"
},
"multiIntValue": {
"description": "Multiple integer values of the parameter.",
"type": "array",
"items": {
"type": "string",
"format": "int64"
}
},
"boolValue": {
"description": "Boolean value of the parameter.",
"type": "boolean"
},
"multiBoolValue": {
"description": "Multiple boolean values of the parameter.",
"type": "array",
"items": {
"type": "boolean"
}
}
}
},
"ActivityNetworkInfo": {
"id": "ActivityNetworkInfo",
"description": "Network information of the user doing the action.",
"type": "object",
"properties": {
"ipAsn": {
"description": "IP Address of the user doing the action.",
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"regionCode": {
"description": "ISO 3166-1 alpha-2 region code of the user doing the action.",
"type": "string"
},
"subdivisionCode": {
"description": "ISO 3166-2 region code (states and provinces) for countries of the user doing the action.",
"type": "string"
}
}
},
"ResourceDetails": {
"id": "ResourceDetails",
"description": "Details of the resource on which the action was performed.",
"type": "object",
"properties": {
"id": {
"description": "Identifier of the resource.",
"type": "string"
},
"title": {
"description": "Title of the resource. For instance, in case of a drive document, this would be the title of the document. In case of an email, this would be the subject.",
"type": "string"
},
"type": {
"description": "Type of the resource - document, email, chat message",
"type": "string"
},
"appliedLabels": {
"description": "List of labels applied on the resource",
"type": "array",
"items": {
"$ref": "AppliedLabel"
}
},
"relation": {
"description": "Defines relationship of the resource to the events",
"type": "string"
}
}
},
"AppliedLabel": {
"id": "AppliedLabel",
"description": "Details of the label applied on the resource.",
"type": "object",
"properties": {
"id": {
"description": "Identifier of the label - Only the label id, not the full OnePlatform resource name.",
"type": "string"
},
"title": {
"description": "Title of the label",
"type": "string"
},
"fieldValues": {
"description": "List of fields which are part of the label and have been set by the user. If label has a field which was not set by the user, it would not be present in this list.",
"type": "array",
"items": {
"$ref": "FieldValue"
}
},
"reason": {
"description": "The reason why the label was applied on the resource.",
"$ref": "Reason"
}
}
},
"FieldValue": {
"id": "FieldValue",
"description": "Details of the field value set by the user for the particular label.",
"type": "object",
"properties": {
"id": {
"description": "Identifier of the field",
"type": "string"
},
"displayName": {
"description": "Display name of the field",
"type": "string"
},
"type": {
"description": "Type of the field",
"type": "string"
},
"unsetValue": {
"description": "If the field is unset, this will be true.",
"type": "boolean"
},
"longTextValue": {
"description": "Setting a long text value.",
"type": "string"
},
"textValue": {
"description": "Setting a text value.",
"type": "string"
},
"textListValue": {
"description": "Setting a text list value.",
"$ref": "FieldValueTextListValue"
},
"selectionValue": {
"description": "Setting a selection value by selecting a single value from a dropdown.",
"$ref": "FieldValueSelectionValue"
},
"selectionListValue": {
"description": "Setting a selection list value by selecting multiple values from a dropdown.",
"$ref": "FieldValueSelectionListValue"
},
"integerValue": {
"description": "Setting an integer value.",
"type": "string",
"format": "int64"
},
"userValue": {
"description": "Setting a user value by selecting a single user.",
"$ref": "FieldValueUserValue"
},
"userListValue": {
"description": "Setting a user list value by selecting multiple users.",
"$ref": "FieldValueUserListValue"
},
"dateValue": {
"description": "Setting a date value.",
"$ref": "Date"
},
"reason": {
"description": "The reason why the field was applied to the label.",
"$ref": "Reason"
}
}
},
"FieldValueTextListValue": {
"id": "FieldValueTextListValue",
"description": "Setting a text list value.",
"type": "object",
"properties": {
"values": {
"description": "List of text values.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FieldValueSelectionValue": {
"id": "FieldValueSelectionValue",
"description": "Setting a selection value by selecting a single value from a dropdown.",
"type": "object",
"properties": {
"id": {
"description": "Identifier of the selection.",
"type": "string"
},
"displayName": {
"description": "Display name of the selection.",
"type": "string"
},
"badged": {
"description": "Whether the selection is badged.",
"type": "boolean"
}
}
},
"FieldValueSelectionListValue": {
"id": "FieldValueSelectionListValue",
"description": "Setting a selection list value by selecting multiple values from a dropdown.",
"type": "object",
"properties": {
"values": {
"description": "List of selections.",
"type": "array",
"items": {
"$ref": "FieldValueSelectionValue"
}
}
}
},
"FieldValueUserValue": {
"id": "FieldValueUserValue",
"description": "Setting a user value by selecting a single user.",
"type": "object",
"properties": {
"email": {
"description": "Email of the user.",
"type": "string"
}
}
},
"FieldValueUserListValue": {
"id": "FieldValueUserListValue",
"description": "Setting a user list value by selecting multiple users.",
"type": "object",
"properties": {
"values": {
"description": "List of users.",
"type": "array",
"items": {
"$ref": "FieldValueUserValue"
}
}
}
},
"Date": {
"id": "Date",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"type": "object",
"properties": {
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"type": "integer",
"format": "int32"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"type": "integer",
"format": "int32"
},
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"type": "integer",
"format": "int32"
}
}
},
"Reason": {
"id": "Reason",
"description": "The reason why the label/field was applied.",
"type": "object",
"properties": {
"reasonType": {
"description": "The type of the reason.",
"type": "string"
}
}
},
"Channel": {
"id": "Channel",
"description": "A notification channel used to watch for resource changes.",
"type": "object",
"properties": {
"id": {
"description": "A UUID or similar unique string that identifies this channel.",
"type": "string"
},
"token": {
"description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
"type": "string"
},
"expiration": {
"description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
"type": "string",
"format": "int64"
},
"type": {
"description": "The type of delivery mechanism used for this channel. The value should be set to \"web_hook\".",
"type": "string"
},
"address": {
"description": "The address where notifications are delivered for this channel.",
"type": "string"
},
"payload": {
"description": "A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the request. Optional.",
"type": "boolean"
},
"params": {
"description": "Additional parameters controlling delivery channel behavior. Optional.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"resourceId": {
"description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
"type": "string"
},
"resourceUri": {
"description": "A version-specific identifier for the watched resource.",
"type": "string"
},
"kind": {
"description": "Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".",
"default": "api#channel",
"type": "string"
}
}
},
"UsageReports": {
"id": "UsageReports",
"type": "object",
"properties": {
"kind": {
"description": "The type of API resource. For a usage report, the value is admin#reports#usageReports.",
"default": "admin#reports#usageReports",
"type": "string"
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"warnings": {
"description": "Warnings, if any.",
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"description": "Machine readable code or warning type. The warning code value is 200.",
"type": "string"
},
"message": {
"description": "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. ",
"type": "string"
},
"data": {
"description": "Key-value pairs to give detailed information on the warning.",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"description": "Key associated with a key-value pair to give detailed information on the warning.",
"type": "string"
},
"value": {
"description": "Value associated with a key-value pair to give detailed information on the warning.",
"type": "string"
}
}
}
}
}
}
},
"usageReports": {
"description": "Various application parameter records.",
"type": "array",
"items": {
"$ref": "UsageReport"
}
},
"nextPageToken": {
"description": "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.",
"type": "string"
}
}
},
"UsageReport": {
"id": "UsageReport",
"description": "JSON template for a usage report.",
"type": "object",
"properties": {
"kind": {
"description": "The type of API resource. For a usage report, the value is admin#reports#usageReport.",
"default": "admin#reports#usageReport",
"type": "string"
},
"date": {
"description": "Output only. The date of the report request.",
"readOnly": true,
"type": "string"
},
"parameters": {
"description": "Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see the Entity Usage parameters reference.",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"intValue": {
"description": "Output only. Integer value of the parameter.",
"readOnly": true,
"type": "string",
"format": "int64"
},
"name": {
"description": "The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference.",
"type": "string"
},
"stringValue": {
"description": "Output only. String value of the parameter.",
"readOnly": true,
"type": "string"
},
"datetimeValue": {
"description": "The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.",
"type": "string",
"format": "date-time",
"readOnly": true
},
"boolValue": {
"description": "Output only. Boolean value of the parameter.",
"readOnly": true,
"type": "boolean"
},
"msgValue": {
"description": "Output only. Nested message value of the parameter.",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object."
}
}
}
}
}
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"entity": {
"description": "Output only. Information about the type of the item.",
"readOnly": true,
"type": "object",
"properties": {
"customerId": {
"description": "Output only. The unique identifier of the customer's account.",
"readOnly": true,
"type": "string"
},
"userEmail": {
"description": "Output only. The user's email address. Only relevant if entity.type = "USER"",
"readOnly": true,
"type": "string"
},
"profileId": {
"description": "Output only. The user's immutable Google Workspace profile identifier.",
"readOnly": true,
"type": "string"
},
"entityId": {
"description": "Output only. Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name of report is "Entities" rather than "Objects".",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Output only. The type of item. The value is user.",
"readOnly": true,
"type": "string"
}
}
}
}
}
},
"packagePath": "admin",
"resources": {
"activities": {
"methods": {
"list": {
"id": "reports.activities.list",
"path": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}",
"flatPath": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}",
"httpMethod": "GET",
"parameters": {
"userKey": {
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call users.list in Directory API with showDeleted=true, then use the returned ID as the userKey.",
"location": "path",
"required": true,
"type": "string"
},
"applicationName": {
"description": "Application name for which the events are to be retrieved.",
"pattern": "(access_evaluation)|(access_transparency)|(admin)|(admin_data_action)|(assignments)|(calendar)|(chat)|(chrome)|(classroom)|(cloud_search)|(contacts)|(context_aware_access)|(data_studio)|(data_migration)|(directory_sync)|(drive)|(gcp)|(gmail)|(gplus)|(graduation)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(ldap)|(login)|(meet)|(meet_hardware)|(mobile)|(profile)|(rules)|(saml)|(token)|(user_accounts)|(vault)|(gemini_in_workspace_apps)|(tasks)|(takeout)",
"location": "path",
"required": true,
"type": "string",
"enumDescriptions": [
"The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
"The Admin console application's activity reports return account information about different types of administrator activity events.",
"The Google Calendar application's activity reports return information about various Calendar activity events.",
"The Chat activity reports return information about various Chat activity events.",
"The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Enterprise customers.",
"The Google Cloud Platform application's activity reports return information about various GCP activity events.",
"The Gmail application's activity reports return information about various Gmail activity events.",
"The Google+ application's activity reports return information about various Google+ activity events.",
"The Google Groups application's activity reports return information about various Groups activity events.",
"The Enterprise Groups activity reports return information about various Enterprise group activity events.",
"The Jamboard activity reports return information about various Jamboard activity events.",
"The Login application's activity reports return account information about different types of Login activity events.",
"The Meet Audit activity report returns information about different types of Meet Audit activity events.",
"The Device Audit activity report returns information about different types of Device Audit activity events.",
"The Rules activity report returns information about different types of Rules activity events.",
"The SAML activity report returns information about different types of SAML activity events.",
"The Token application's activity reports return account information about different types of Token activity events.",
"The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
"The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
"The Chrome activity reports return information about Chrome browser and Chrome OS events.",
"The Data Studio activity reports return information about various types of Data Studio activity events.",
"The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers.",
"The Vault activity reports return information about various types of Vault activity events.",
"The Gemini for Workspace activity reports return information about various types of Gemini activity events performed by users within a Workspace application.",
"The Classroom activity reports return information about different types of Classroom activity events.",
"The assignments application's activity reports return information about various types of assignments activity events.",
"The Cloud Search application's activity reports return information about various types of cloud_search activity events.",
"The Tasks application's activity reports return information about various types of Tasks activity events.",
"The Data Migration application's activity reports return information about various types of data migration activity events.",
"The Meet Hardware application's activity reports return information about various types of Meet Hardware activity events.",
"The Directory Sync application's activity reports return information about various types of Directory Sync activity events.",
"The ldap application's activity reports return information about various types of ldap activity events.",
"The Profile application's activity reports return information about various types of Profile activity events.",
"The Access Evaluation activity reports return information about various types of Access Evaluation activity events.",
"The Admin Data Action application's activity reports return information about various types of Admin Data Action activity events.",
"The Contacts application's activity reports return information about various types of Contacts activity events.",
"The Takeout application's activity reports return information about various types of Takeout activity events.",
"The Graduation application's activity reports return information about various types of Graduation activity events."
],
"enum": [
"access_transparency",
"admin",
"calendar",
"chat",
"drive",
"gcp",
"gmail",
"gplus",
"groups",
"groups_enterprise",
"jamboard",
"login",
"meet",
"mobile",
"rules",
"saml",
"token",
"user_accounts",
"context_aware_access",
"chrome",
"data_studio",
"keep",
"vault",
"gemini_in_workspace_apps",
"classroom",
"assignments",
"cloud_search",
"tasks",
"data_migration",
"meet_hardware",
"directory_sync",
"ldap",
"profile",
"access_evaluation",
"admin_data_action",
"contacts",
"takeout",
"graduation"
]
},
"actorIpAddress": {
"description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
"location": "query",
"type": "string"
},
"customerId": {
"description": "The unique ID of the customer to retrieve data for.",
"pattern": "C.+|my_customer",
"location": "query",
"type": "string"
},
"endTime": {
"description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - Date of the API's request for a report: When the API created and retrieved the report. - Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past. For Gmail requests, startTime and endTime must be provided and the difference must not be greater than 30 days.",
"pattern": "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))",
"location": "query",
"type": "string"
},
"eventName": {
"description": "The name of the event being queried by the API. Each eventName is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.",
"location": "query",
"type": "string"
},
"filters": {
"description": "The filters query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},... These event parameters are associated with a specific eventName. An empty report is returned if the request's parameter doesn't belong to the eventName. For more information about the available eventName fields for each application and their associated parameters, go to the ApplicationName table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all edit events where the doc_id parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a doc_id value equal to 12345. In the second example, the report returns any edited documents where the doc_id value is not equal to 98765. The \u003c\u003e operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 A filters query supports these relational operators: * ==—'equal to'. * \u003c\u003e—'not equal to'. Must be URL-encoded (%3C%3E). * \u003c—'less than'. Must be URL-encoded (%3C). * \u003c=—'less than or equal to'. Must be URL-encoded (%3C=). * \u003e—'greater than'. Must be URL-encoded (%3E). * \u003e=—'greater than or equal to'. Must be URL-encoded (%3E=). Note: The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.",
"pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000.",
"default": "1000",
"minimum": "1",
"maximum": "1000",
"location": "query",
"type": "integer",
"format": "int32"
},
"orgUnitID": {
"description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
"pattern": "(id:[a-z0-9]+)",
"default": "",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
"location": "query",
"type": "string"
},
"startTime": {
"description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. For Gmail requests, startTime and endTime must be provided and the difference must not be greater than 30 days.",
"pattern": "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))",
"location": "query",
"type": "string"
},
"groupIdFilter": {
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" Important: To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see Filter results by Google Group",
"pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+))",
"location": "query",
"type": "string"
},
"resourceDetailsFilter": {
"description": "Optional. The resourceDetailsFilter query string is an AND separated list composed of Resource Details fields manipulated by relational operators. Resource Details Filters are in the form {resourceDetails.field1}{relational operator}{field1 value} AND {resourceDetails.field2}{relational operator}{field2 value}... All the inner fields are traversed using the . operator, as shown in the following example: resourceDetails.id = \"resourceId\" AND resourceDetails.appliedLabels.id = \"appliedLabelId\" AND resourceDetails.appliedLabels.fieldValue.id = \"fieldValueId\" resourceDetailsFilter query supports these relational operators: * =—'equal to'. * !=—'not equal to'. * :—'exists'. This is used for filtering on repeated fields. FieldValue types that are repeated in nature uses exists operator for filtering. The following FieldValue types are repeated: * TextListValue * SelectionListValue * UserListValue For example, in the following filter, SelectionListValue, is a repeated field. The filter checks whether SelectionListValue contains selection_id: resourceDetails.id = \"resourceId\" AND resourceDetails.appliedLabels.id = \"appliedLabelId\" AND resourceDetails.appliedLabels.fieldValue.id = \"fieldValueId\" AND resourceDetails.appliedLabels.fieldValue.type = \"SELECTION_LIST_VALUE\" AND resourceDetails.appliedLabels.fieldValue.selectionListValue.id: \"id\" Usage GET...&resourceDetailsFilter=resourceDetails.id = \"resourceId\" AND resourceDetails.appliedLabels.id = \"appliedLabelId\" GET...&resourceDetailsFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLabels.id=%22appliedLabelId%22 Note the following: * You must URL encode the query string before sending the request. * The API supports a maximum of 5 fields separated by the AND operator. - When filtering on deeper levels (e.g., AppliedLabel, FieldValue), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on FieldValue requires AppliedLabel ID and resourceDetails ID to be present. Sample Query: resourceDetails.id = \"resourceId\" AND resourceDetails.appliedLabels.id = \"appliedLabelId\" AND resourceDetails.appliedLabels.fieldValue.id = \"fieldValueId\" * Filtering on inner FieldValue types like longTextValue and textValue requires resourceDetails.appliedLabels.fieldValue.type to be present. * Only Filtering on a single AppliedLabel id and FieldValue id is supported.",
"location": "query",
"type": "string"
}
},
"parameterOrder": [
"userKey",
"applicationName"
],
"response": {
"$ref": "Activities"
},
"scopes": [
"https://www.googleapis.com/auth/admin.reports.audit.readonly"
],
"description": "Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. "
},
"watch": {
"id": "reports.activities.watch",
"path": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch",
"flatPath": "admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch",
"httpMethod": "POST",
"parameters": {
"userKey": {
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call users.list in Directory API with showDeleted=true, then use the returned ID as the userKey.",
"location": "path",
"required": true,
"type": "string"
},
"applicationName": {
"description": "Application name for which the events are to be retrieved.",
"pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(classroom)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
"location": "path",
"required": true,
"type": "string",
"enumDescriptions": [
"The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
"The Admin console application's activity reports return account information about different types of administrator activity events.",
"The Google Calendar application's activity reports return information about various Calendar activity events.",
"The Chat activity reports return information about various Chat activity events.",
"The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for Google Workspace Business and Google Workspace Enterprise customers.",
"The Google Cloud Platform application's activity reports return information about various GCP activity events.",
"The Google+ application's activity reports return information about various Google+ activity events.",
"The Google Groups application's activity reports return information about various Groups activity events.",
"The Enterprise Groups activity reports return information about various Enterprise group activity events.",
"The Jamboard activity reports return information about various Jamboard activity events.",
"The Login application's activity reports return account information about different types of Login activity events.",
"The Meet Audit activity report returns information about different types of Meet Audit activity events.",
"The Device Audit activity report returns information about different types of Device Audit activity events.",
"The Rules activity report returns information about different types of Rules activity events.",
"The SAML activity report returns information about different types of SAML activity events.",
"The Token application's activity reports return account information about different types of Token activity events.",
"The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
"The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
"The Chrome activity reports return information about Chrome browser and Chrome OS events.",
"The Data Studio activity reports return information about various types of Data Studio activity events.",
"The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers.",
"The Classroom activity reports return information about different types of Classroom activity events."
],
"enum": [
"access_transparency",
"admin",
"calendar",
"chat",
"drive",
"gcp",
"gplus",
"groups",
"groups_enterprise",
"jamboard",
"login",
"meet",
"mobile",
"rules",
"saml",
"token",
"user_accounts",
"context_aware_access",
"chrome",
"data_studio",
"keep",
"classroom"
]
},
"actorIpAddress": {
"description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
"location": "query",
"type": "string"
},
"customerId": {
"description": "The unique ID of the customer to retrieve data for.",
"pattern": "C.+|my_customer",
"location": "query",
"type": "string"
},
"endTime": {
"description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - Date of the API's request for a report: When the API created and retrieved the report. - Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.",
"pattern": "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))",
"location": "query",
"type": "string"
},
"eventName": {
"description": "The name of the event being queried by the API. Each eventName is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.",
"location": "query",
"type": "string"
},
"filters": {
"description": "The filters query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},... These event parameters are associated with a specific eventName. An empty report is returned if the request's parameter doesn't belong to the eventName. For more information about the available eventName fields for each application and their associated parameters, go to the ApplicationName table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all edit events where the doc_id parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a doc_id value equal to 12345. In the second example, the report returns any edited documents where the doc_id value is not equal to 98765. The \u003c\u003e operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 A filters query supports these relational operators: * ==—'equal to'. * \u003c\u003e—'not equal to'. Must be URL-encoded (%3C%3E). * \u003c—'less than'. Must be URL-encoded (%3C). * \u003c=—'less than or equal to'. Must be URL-encoded (%3C=). * \u003e—'greater than'. Must be URL-encoded (%3E). * \u003e=—'greater than or equal to'. Must be URL-encoded (%3E=). Note: The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.",
"pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000.",
"default": "1000",
"minimum": "1",
"maximum": "1000",
"location": "query",
"type": "integer",
"format": "int32"
},
"orgUnitID": {
"description": "Deprecated. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
"pattern": "(id:[a-z0-9]+)",
"default": "",
"location": "query",
"deprecated": true,
"type": "string"
},
"pageToken": {
"description": "The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
"location": "query",
"type": "string"
},
"startTime": {
"description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.",
"pattern": "(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(?:\.(\d+))?(?:(Z)|([-+])(\d\d):(\d\d))",
"location": "query",
"type": "string"
},
"groupIdFilter": {
"description": "Deprecated. This field is deprecated and is no longer supported. Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" Important: To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see Filter results by Google Group",
"pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+))",
"location": "query",
"deprecated": true,
"type": "string"
}
},
"parameterOrder": [
"userKey",
"applicationName"
],
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/admin.reports.audit.readonly"
],
"description": "Start receiving notifications for account activities. For more information, see Receiving Push Notifications."
}
}
},
"channels": {
"methods": {
"stop": {
"id": "admin.channels.stop",
"path": "admin/reports_v1/channels/stop",
"flatPath": "admin/reports_v1/channels/stop",
"httpMethod": "POST",
"parameters": {},
"parameterOrder": [],
"request": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/admin.reports.audit.readonly"
],
"description": "Stop watching resources through this channel."
}
}
},
"customerUsageReports": {
"methods": {
"get": {
"id": "reports.customerUsageReports.get",
"path": "admin/reports/v1/usage/dates/{date}",
"flatPath": "admin/reports/v1/usage/dates/{date}",
"httpMethod": "GET",
"parameters": {
"date": {
"description": "Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the ISO 8601 format, yyyy-mm-dd.",
"pattern": "(\d){4}-(\d){2}-(\d){2}",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "The unique ID of the customer to retrieve data for.",
"pattern": "C.+|my_customer",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "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.",
"location": "query",
"type": "string"
},
"parameters": {
"description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, chat, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
"pattern": "(((accounts)|(app_maker)|(apps_scripts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)(((accounts)|(app_maker)|(apps_scripts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
"location": "query",
"type": "string"
}
},
"parameterOrder": [
"date"
],
"response": {
"$ref": "UsageReports"
},
"scopes": [
"https://www.googleapis.com/auth/admin.reports.usage.readonly"
],
"description": "Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides. "
}
}
},
"entityUsageReports": {
"methods": {
"get": {
"id": "reports.entityUsageReports.get",
"path": "admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}",
"flatPath": "admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}",
"httpMethod": "GET",
"parameters": {
"entityType": {
"description": "Represents the type of entity for the report.",
"pattern": "(gplus_communities)",
"location": "path",
"required": true,
"type": "string",
"enumDescriptions": [
"Returns a report on Google+ communities."
],
"enum": [
"gplus_communities"
]
},
"entityKey": {
"description": "Represents the key of the object to filter the data with. It is a string which can take the value all to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the entityKey for a particular entityType, see the Entities Usage parameters reference guides.",
"location": "path",
"required": true,
"type": "string"
},
"date": {
"description": "Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the ISO 8601 format, yyyy-mm-dd.",
"pattern": "(\d){4}-(\d){2}-(\d){2}",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "The unique ID of the customer to retrieve data for.",
"pattern": "C.+|my_customer",
"location": "query",
"type": "string"
},
"filters": {
"description": "The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include accounts, docs, and gmail. Filters are in the form [application name]:parameter name[parameter value],.... In this example, the \u003c\u003e 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - == - 'equal to'. - \u003c\u003e - 'not equal to'. It is URL-encoded (%3C%3E). - \u003c - 'less than'. It is URL-encoded (%3C). - \u003c= - 'less than or equal to'. It is URL-encoded (%3C=). - \u003e - 'greater than'. It is URL-encoded (%3E). - \u003e= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.",
"pattern": "(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page.",
"default": "1000",
"minimum": "1",
"maximum": "1000",
"location": "query",
"type": "integer",
"format": "uint32"
},
"pageToken": {
"description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
"location": "query",
"type": "string"
},
"parameters": {
"description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only gplus. A parameter query string is in the CSV form of [app_name1:param_name1], [app_name2:param_name2].... Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
"pattern": "(((gplus)):[^,]+,)(((gplus)):[^,]+)",
"location": "query",
"type": "string"
}
},
"parameterOrder": [
"entityType",
"entityKey",
"date"
],
"response": {
"$ref": "UsageReports"
},
"scopes": [
"https://www.googleapis.com/auth/admin.reports.usage.readonly"
],
"description": "Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides."
}
}
},
"userUsageReport": {
"methods": {
"get": {
"id": "reports.userUsageReport.get",
"path": "admin/reports/v1/usage/users/{userKey}/dates/{date}",
"flatPath": "admin/reports/v1/usage/users/{userKey}/dates/{date}",
"httpMethod": "GET",
"parameters": {
"userKey": {
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call users.list in Directory API with showDeleted=true, then use the returned ID as the userKey.",
"location": "path",
"required": true,
"type": "string"
},
"date": {
"description": "Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the ISO 8601 format, yyyy-mm-dd.",
"pattern": "(\d){4}-(\d){2}-(\d){2}",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
"description": "The unique ID of the customer to retrieve data for.",
"pattern": "C.+|my_customer",
"location": "query",
"type": "string"
},
"filters": {
"description": "The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include accounts, chat, docs, and gmail. Filters are in the form [application name]:parameter name[parameter value],.... In this example, the \u003c\u003e 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - == - 'equal to'. - \u003c\u003e - 'not equal to'. It is URL-encoded (%3C%3E). - \u003c - 'less than'. It is URL-encoded (%3C). - \u003c= - 'less than or equal to'. It is URL-encoded (%3C=). - \u003e - 'greater than'. It is URL-encoded (%3E). - \u003e= - 'greater than or equal to'. It is URL-encoded (%3E=). ",
"pattern": "(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional.",
"default": "1000",
"minimum": "1",
"maximum": "1000",
"location": "query",
"type": "integer",
"format": "uint32"
},
"orgUnitID": {
"description": "ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
"pattern": "(id:[a-z0-9]+)",
"default": "",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
"location": "query",
"type": "string"
},
"parameters": {
"description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include accounts, app_maker, apps_scripts, calendar, chat, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ",
"pattern": "(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
"location": "query",
"type": "string"
},
"groupIdFilter": {
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456"",
"pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+))",
"location": "query",
"type": "string"
}
},
"parameterOrder": [
"userKey",
"date"
],
"response": {
"$ref": "UsageReports"
},
"scopes": [
"https://www.googleapis.com/auth/admin.reports.usage.readonly"
],
"description": "Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides."
}
}
}
},
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://admin.mtls.googleapis.com/",
"servicePath": "",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/admin.reports.audit.readonly": {
"description": "View audit reports for your Google Workspace domain"
},
"https://www.googleapis.com/auth/admin.reports.usage.readonly": {
"description": "View usage reports for your Google Workspace domain"
}
}
}
},
"discoveryVersion": "v1",
"batchPath": "batch",
"documentationLink": "https://developers.google.com/workspace/admin/",
"title": "Admin SDK API",
"id": "admin:reports_v1",
"parameters": {
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"alt": {
"type": "string",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query"
},
"callback": {
"type": "string",
"description": "JSONP",
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. "raw", "multipart").",
"location": "query"
},
"uploadType": {
"type": "string",
"description": "Legacy upload protocol for media (e.g. "media", "multipart").",
"location": "query"
},
"$.xgafv": {
"type": "string",
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
}
},
"protocol": "rest",
"rootUrl": "https://admin.googleapis.com/",
"baseUrl": "https://admin.googleapis.com/",
"description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
"name": "admin",
"version": "reports_v1",
"fullyEncodeReservedExpansion": true,
"revision": "20260113"
}
|
Hey can you assign this issue to me? |
|
Moving this to 1.112 and disabling auto merge so that we can get the 1.111 milestone into good shape by the end of Thursday Please take this in as a candidate if it must go into 1.111 |
8 participants
fix: #224728