OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-18 17:30:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

update all json files

Browse Source
This commit is contained in:
Sebastian Thiel
2020-04-12 18:55:37 +08:00
parent ea3b428364
commit aacc30f08d
260 changed files with 138411 additions and 26293 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
etc/api/admin/datatransfer_v1/admin-api.json
View File

@@ -18,7 +18,7 @@
"description": "Transfers user data from one user to another.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/sO76R3ImJWyHTWFAs7zvdNuGNOQ\"",
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/o-H78Id0Lcq1iHheSzpqURY4CLE\"",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
@@ -109,7 +109,7 @@
"id": "datatransfer.applications.list",
"parameters": {
"customerId": {
"description": "Immutable ID of the Google Apps account.",
"description": "Immutable ID of the G Suite account.",
"location": "query",
"type": "string"
},
@@ -185,7 +185,7 @@
"id": "datatransfer.transfers.list",
"parameters": {
"customerId": {
"description": "Immutable ID of the Google Apps account.",
"description": "Immutable ID of the G Suite account.",
"location": "query",
"type": "string"
},
@@ -230,7 +230,7 @@
}
}
},
"revision": "20160223",
"revision": "20191105",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Application": {
@@ -256,7 +256,7 @@
"type": "string"
},
"transferParams": {
"description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.",
"description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred.",
"items": {
"$ref": "ApplicationTransferParam"
},
@@ -275,7 +275,7 @@
"type": "string"
},
"applicationTransferParams": {
"description": "The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.",
"description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.",
"items": {
"$ref": "ApplicationTransferParam"
},
@@ -297,7 +297,7 @@
"type": "string"
},
"value": {
"description": "The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
"description": "The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
"items": {
"type": "string"
},
@@ -358,11 +358,11 @@
"type": "string"
},
"newOwnerUserId": {
"description": "ID of the user to whom the data is being transfered.",
"description": "ID of the user to whom the data is being transferred.",
"type": "string"
},
"oldOwnerUserId": {
"description": "ID of the user whose data is being transfered.",
"description": "ID of the user whose data is being transferred.",
"type": "string"
},
"overallTransferStatusCode": {

194
etc/api/admin/directory_v1/admin-api.json
View File

@@ -82,6 +82,9 @@
},
"https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
"description": "View user schemas on your domain"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -93,7 +96,7 @@
"description": "Manages enterprise resources such as users and groups, administrative notifications, security features, and more.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/admin-sdk/directory/",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/eWNDpeAZuk1gV8zhFqMfz4qmrho\"",
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/Q_N7e9cs3A1-s8__TCCHlsbCI_c\"",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
@@ -252,7 +255,8 @@
"https://www.googleapis.com/auth/admin.directory.user",
"https://www.googleapis.com/auth/admin.directory.user.alias",
"https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
"https://www.googleapis.com/auth/admin.directory.user.readonly"
"https://www.googleapis.com/auth/admin.directory.user.readonly",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
@@ -348,7 +352,8 @@
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 100",
"default": "100",
"description": "Maximum number of results to return. Max allowed value is 200.",
"format": "int32",
"location": "query",
"minimum": "1",
@@ -938,7 +943,8 @@
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 200",
"default": "200",
"description": "Maximum number of results to return. Max allowed value is 200.",
"format": "int32",
"location": "query",
"minimum": "1",
@@ -979,7 +985,7 @@
"type": "string"
},
"userKey": {
"description": "Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object",
"description": "Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.",
"location": "query",
"type": "string"
}
@@ -1274,7 +1280,8 @@
"type": "boolean"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 200",
"default": "200",
"description": "Maximum number of results to return. Max allowed value is 200.",
"format": "int32",
"location": "query",
"minimum": "1",
@@ -1492,7 +1499,8 @@
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 100",
"default": "100",
"description": "Maximum number of results to return. Max allowed value is 100.",
"format": "int32",
"location": "query",
"minimum": "1",
@@ -1967,28 +1975,6 @@
}
}
},
"resolvedAppAccessSettings": {
"methods": {
"GetSettings": {
"description": "Retrieves resolved app access settings of the logged in user.",
"httpMethod": "GET",
"id": "directory.resolvedAppAccessSettings.GetSettings",
"path": "resolvedappaccesssettings",
"response": {
"$ref": "AppAccessCollections"
}
},
"ListTrustedApps": {
"description": "Retrieves the list of apps trusted by the admin of the logged in user.",
"httpMethod": "GET",
"id": "directory.resolvedAppAccessSettings.ListTrustedApps",
"path": "trustedapps",
"response": {
"$ref": "TrustedApps"
}
}
}
},
"resources": {
"resources": {
"buildings": {
@@ -3378,7 +3364,8 @@
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 100. Max allowed is 500",
"default": "100",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "500",
@@ -3427,7 +3414,7 @@
"type": "string"
},
"showDeleted": {
"description": "If set to true retrieves the list of deleted users. Default is false",
"description": "If set to true, retrieves the list of deleted users. (Default: false)",
"location": "query",
"type": "string"
},
@@ -3465,7 +3452,8 @@
},
"scopes": [
"https://www.googleapis.com/auth/admin.directory.user",
"https://www.googleapis.com/auth/admin.directory.user.readonly"
"https://www.googleapis.com/auth/admin.directory.user.readonly",
"https://www.googleapis.com/auth/cloud-platform"
],
"supportsSubscription": true
},
@@ -3607,7 +3595,8 @@
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Default is 100. Max allowed is 500",
"default": "100",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "500",
@@ -3656,7 +3645,7 @@
"type": "string"
},
"showDeleted": {
"description": "If set to true retrieves the list of deleted users. Default is false",
"description": "If set to true, retrieves the list of deleted users. (Default: false)",
"location": "query",
"type": "string"
},
@@ -3698,7 +3687,8 @@
},
"scopes": [
"https://www.googleapis.com/auth/admin.directory.user",
"https://www.googleapis.com/auth/admin.directory.user.readonly"
"https://www.googleapis.com/auth/admin.directory.user.readonly",
"https://www.googleapis.com/auth/cloud-platform"
],
"supportsSubscription": true
}
@@ -4017,7 +4007,7 @@
}
}
},
"revision": "20190214",
"revision": "20200204",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Alias": {
@@ -4071,50 +4061,6 @@
},
"type": "object"
},
"AppAccessCollections": {
"description": "JSON template for App Access Collections Resource object in Directory API.",
"id": "AppAccessCollections",
"properties": {
"blockedApiAccessBuckets": {
"description": "List of blocked api access buckets.",
"items": {
"type": "string"
},
"type": "array"
},
"enforceSettingsForAndroidDrive": {
"description": "Boolean to indicate whether to enforce app access settings on Android Drive or not.",
"type": "boolean"
},
"errorMessage": {
"description": "Error message provided by the Admin that will be shown to the user when an app is blocked.",
"type": "string"
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"kind": {
"default": "admin#directory#appaccesscollection",
"description": "Identifies the resource as an app access collection. Value: admin#directory#appaccesscollection",
"type": "string"
},
"resourceId": {
"description": "Unique ID of app access collection. (Readonly)",
"format": "int64",
"type": "string"
},
"resourceName": {
"description": "Resource name given by the customer while creating/updating. Should be unique under given customer.",
"type": "string"
},
"trustDomainOwnedApps": {
"description": "Boolean that indicates whether to trust domain owned apps.",
"type": "boolean"
}
},
"type": "object"
},
"Asp": {
"description": "The template that returns individual ASP (Access Code) data.",
"id": "Asp",
@@ -4494,6 +4440,11 @@
"description": "User of the device",
"type": "string"
},
"autoUpdateExpiration": {
"description": "(Read-only) The timestamp after which the device will stop receiving Chrome updates or support",
"format": "int64",
"type": "string"
},
"bootMode": {
"description": "Chromebook boot mode (Read-only)",
"type": "string"
@@ -4599,6 +4550,10 @@
},
"type": "array"
},
"dockMacAddress": {
"description": "(Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices.",
"type": "string"
},
"etag": {
"description": "ETag of the resource.",
"type": "string"
@@ -4607,6 +4562,10 @@
"description": "Chromebook Mac Address on ethernet network interface (Read-only)",
"type": "string"
},
"ethernetMacAddress0": {
"description": "(Read-only) MAC address used by the Chromebook\u2019s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.",
"type": "string"
},
"firmwareVersion": {
"description": "Chromebook firmware version (Read-only)",
"type": "string"
@@ -4630,8 +4589,12 @@
"description": "Chromebook Mac Address on wifi network interface (Read-only)",
"type": "string"
},
"manufactureDate": {
"description": "(Read-only) The date the device was manufactured in yyyy-mm-dd format.",
"type": "string"
},
"meid": {
"description": "Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)",
"description": "Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only)",
"type": "string"
},
"model": {
@@ -5216,7 +5179,7 @@
"type": "string"
},
"id": {
"description": "Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)",
"description": "The unique ID of the group member. A member id can be used as a member request URI's memberKey. Unique identifier of group (Read-only) Unique identifier of member (Read-only)",
"type": "string"
},
"kind": {
@@ -5709,7 +5672,7 @@
"type": "string"
},
"serviceId": {
"description": "The obfuscated ID of the service this privilege is for.",
"description": "The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().",
"type": "string"
},
"serviceName": {
@@ -5795,7 +5758,7 @@
"type": "string"
},
"serviceId": {
"description": "The obfuscated ID of the service this privilege is for.",
"description": "The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().",
"type": "string"
}
},
@@ -6116,59 +6079,6 @@
},
"type": "object"
},
"TrustedAppId": {
"description": "JSON template for Trusted App Ids Resource object in Directory API.",
"id": "TrustedAppId",
"properties": {
"androidPackageName": {
"description": "Android package name.",
"type": "string"
},
"certificateHashSHA1": {
"description": "SHA1 signature of the app certificate.",
"type": "string"
},
"certificateHashSHA256": {
"description": "SHA256 signature of the app certificate.",
"type": "string"
},
"etag": {
"type": "string"
},
"kind": {
"default": "admin#directory#trustedappid",
"description": "Identifies the resource as a trusted AppId.",
"type": "string"
}
},
"type": "object"
},
"TrustedApps": {
"description": "JSON template for Trusted Apps response object of a user in Directory API.",
"id": "TrustedApps",
"properties": {
"etag": {
"description": "ETag of the resource.",
"type": "string"
},
"kind": {
"default": "admin#directory#trustedapplist",
"description": "Identifies the resource as trusted apps response.",
"type": "string"
},
"nextPageToken": {
"type": "string"
},
"trustedApps": {
"description": "Trusted Apps list.",
"items": {
"$ref": "TrustedAppId"
},
"type": "array"
}
},
"type": "object"
},
"User": {
"description": "JSON template for User object in Directory API.",
"id": "User",
@@ -6350,6 +6260,14 @@
"description": "username of User",
"type": "string"
},
"recoveryEmail": {
"description": "Recovery email of the user.",
"type": "string"
},
"recoveryPhone": {
"description": "Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.",
"type": "string"
},
"relations": {
"type": "any"
},
@@ -6693,7 +6611,7 @@
"type": "string"
},
"fullTimeEquivalent": {
"description": "The full-time equivalent percent within the organization (100000 = 100%).",
"description": "The full-time equivalent millipercent within the organization (100000 = 100%).",
"format": "int32",
"type": "integer"
},

280
etc/api/admin/reports_v1/admin-api.json
View File

@@ -17,8 +17,8 @@
"canonicalName": "reports",
"description": "Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/admin-sdk/reports/",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Tjl9ZZXM6pyNHTApQara35wGpUg\"",
"documentationLink": "/admin-sdk/reports/",
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/cjy_qN1sx94qX1efDr-Kt6Rsqlk\"",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
@@ -79,7 +79,7 @@
"activities": {
"methods": {
"list": {
"description": "Retrieves a list of activities for a specific customer and application.",
"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.",
"httpMethod": "GET",
"id": "reports.activities.list",
"parameterOrder": [
@@ -88,42 +88,81 @@
],
"parameters": {
"actorIpAddress": {
"description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
"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"
},
"applicationName": {
"description": "Application name for which the events are to be retrieved.",
"enum": [
"access_transparency",
"admin",
"calendar",
"chat",
"drive",
"gcp",
"gplus",
"groups",
"groups_enterprise",
"jamboard",
"login",
"meet",
"mobile",
"rules",
"saml",
"token",
"user_accounts"
],
"enumDescriptions": [
"The G Suite 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 G Suite 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 G Suite Business 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 return information about different types of Meet Audit activity events.",
"The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
"The Rules activity report return information about different types of Rules activity events.",
"The SAML activity report return 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."
],
"location": "path",
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)",
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)|(gcp)",
"required": true,
"type": "string"
},
"customerId": {
"description": "Represents the customer for which the data is to be fetched.",
"description": "The unique ID of the customer to retrieve data for.",
"location": "query",
"pattern": "C.+",
"type": "string"
},
"endTime": {
"description": "Return events which occurred at or before this time.",
"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: \n- Date of the API's request for a report: When the API created and retrieved the report. \n- 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. \n- 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.",
"location": "query",
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
"type": "string"
},
"eventName": {
"description": "Name of the event being queried.",
"description": "The name of the event being queried by the API. Each eventName is related to a specific G Suite 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": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
"description": "The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... \nThese event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName.\n\nIn the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E):\nGET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS\n\nIn the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E):\n\nGET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=). \nNote: 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.\nIn 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. If no parameters are requested, all parameters are returned.",
"location": "query",
"pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
"type": "string"
},
"maxResults": {
"description": "Number of activity records to be shown in each page.",
"default": "1000",
"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.",
"format": "int32",
"location": "query",
"maximum": "1000",
@@ -132,24 +171,24 @@
},
"orgUnitID": {
"default": "",
"description": "the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)",
"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.",
"location": "query",
"pattern": "(id:[a-z0-9]+)",
"type": "string"
},
"pageToken": {
"description": "Token to specify next page.",
"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": "Return events which occurred at or after this time.",
"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.",
"location": "query",
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
"type": "string"
},
"userKey": {
"description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
"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 G Suite profile ID or their primary email address.",
"location": "path",
"required": true,
"type": "string"
@@ -165,7 +204,7 @@
"supportsSubscription": true
},
"watch": {
"description": "Push changes to activities",
"description": "Start receiving notifications for account activities. For more information, see Receiving Push Notifications.",
"httpMethod": "POST",
"id": "reports.activities.watch",
"parameterOrder": [
@@ -174,42 +213,81 @@
],
"parameters": {
"actorIpAddress": {
"description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
"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"
},
"applicationName": {
"description": "Application name for which the events are to be retrieved.",
"enum": [
"access_transparency",
"admin",
"calendar",
"chat",
"drive",
"gcp",
"gplus",
"groups",
"groups_enterprise",
"jamboard",
"login",
"meet",
"mobile",
"rules",
"saml",
"token",
"user_accounts"
],
"enumDescriptions": [
"The G Suite 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 G Suite 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 G Suite Business 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 return information about different types of Meet Audit activity events.",
"The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
"The Rules activity report return information about different types of Rules activity events.",
"The SAML activity report return 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."
],
"location": "path",
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)",
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)|(gcp)",
"required": true,
"type": "string"
},
"customerId": {
"description": "Represents the customer for which the data is to be fetched.",
"description": "The unique ID of the customer to retrieve data for.",
"location": "query",
"pattern": "C.+",
"type": "string"
},
"endTime": {
"description": "Return events which occurred at or before this time.",
"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: \n- Date of the API's request for a report: When the API created and retrieved the report. \n- 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. \n- 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.",
"location": "query",
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
"type": "string"
},
"eventName": {
"description": "Name of the event being queried.",
"description": "The name of the event being queried by the API. Each eventName is related to a specific G Suite 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": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
"description": "The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... \nThese event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName.\n\nIn the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E):\nGET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS\n\nIn the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E):\n\nGET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=). \nNote: 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.\nIn 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. If no parameters are requested, all parameters are returned.",
"location": "query",
"pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
"type": "string"
},
"maxResults": {
"description": "Number of activity records to be shown in each page.",
"default": "1000",
"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.",
"format": "int32",
"location": "query",
"maximum": "1000",
@@ -218,24 +296,24 @@
},
"orgUnitID": {
"default": "",
"description": "the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)",
"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.",
"location": "query",
"pattern": "(id:[a-z0-9]+)",
"type": "string"
},
"pageToken": {
"description": "Token to specify next page.",
"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": "Return events which occurred at or after this time.",
"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.",
"location": "query",
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
"type": "string"
},
"userKey": {
"description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
"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 G Suite profile ID or their primary email address.",
"location": "path",
"required": true,
"type": "string"
@@ -276,7 +354,7 @@
"customerUsageReports": {
"methods": {
"get": {
"description": "Retrieves a report which is a collection of properties / statistics for a specific customer.",
"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.",
"httpMethod": "GET",
"id": "reports.customerUsageReports.get",
"parameterOrder": [
@@ -284,25 +362,25 @@
],
"parameters": {
"customerId": {
"description": "Represents the customer for which the data is to be fetched.",
"description": "The unique ID of the customer to retrieve data for.",
"location": "query",
"pattern": "C.+",
"type": "string"
},
"date": {
"description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
"description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
"location": "path",
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
"required": true,
"type": "string"
},
"pageToken": {
"description": "Token to specify next page.",
"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": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
"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, classroom, cros, docs, gmail, gplus, device_management, meet, and sites.\nA parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2.\nNote: 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.\nIn 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.\n\nAn example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.",
"location": "query",
"pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
"type": "string"
@@ -321,7 +399,7 @@
"entityUsageReports": {
"methods": {
"get": {
"description": "Retrieves a report which is a collection of properties / statistics for a set of objects.",
"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.",
"httpMethod": "GET",
"id": "reports.entityUsageReports.get",
"parameterOrder": [
@@ -331,51 +409,67 @@
],
"parameters": {
"customerId": {
"description": "Represents the customer for which the data is to be fetched.",
"description": "The unique ID of the customer to retrieve data for.",
"location": "query",
"pattern": "C.+",
"type": "string"
},
"date": {
"description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
"description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
"location": "path",
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
"required": true,
"type": "string"
},
"entityKey": {
"description": "Represents the key of object for which the data should be filtered.",
"description": "Represents the key of the object to filter the data with.",
"enum": [
"all",
"entityKey"
],
"enumDescriptions": [
"Returns activity events for all users.",
"Represents an app-specific identifier for the 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"
},
"entityType": {
"description": "Type of object. Should be one of - gplus_communities.",
"description": "Represents the type of entity for the report.",
"enum": [
"gplus_communities"
],
"enumDescriptions": [
"Returns a report on Google+ communities."
],
"location": "path",
"pattern": "(gplus_communities)",
"required": true,
"type": "string"
},
"filters": {
"description": "Represents the set of filters including parameter operator value.",
"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.\nFilters are in the form [application name]:[parameter name][relational operator][parameter value],....\n\nIn this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E):\nGET 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>0\n\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.",
"location": "query",
"pattern": "(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Maximum allowed is 1000",
"default": "1000",
"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.",
"format": "uint32",
"location": "query",
"maximum": "1000",
"minimum": "1",
"type": "integer"
},
"pageToken": {
"description": "Token to specify next page.",
"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": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
"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.\nA parameter query string is in the CSV form of [app_name1:param_name1], [app_name2:param_name2]....\nNote: 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.\nIn 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.\n\nAn example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.",
"location": "query",
"pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)",
"type": "string"
@@ -394,7 +488,7 @@
"userUsageReport": {
"methods": {
"get": {
"description": "Retrieves a report which is a collection of properties / statistics for a set of users.",
"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.",
"httpMethod": "GET",
"id": "reports.userUsageReport.get",
"parameterOrder": [
@@ -403,51 +497,53 @@
],
"parameters": {
"customerId": {
"description": "Represents the customer for which the data is to be fetched.",
"description": "The unique ID of the customer to retrieve data for.",
"location": "query",
"pattern": "C.+",
"type": "string"
},
"date": {
"description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
"description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
"location": "path",
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
"required": true,
"type": "string"
},
"filters": {
"description": "Represents the set of filters including parameter operator value.",
"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, docs, and gmail.\nFilters are in the form [application name]:[parameter name][relational operator][parameter value],....\n\nIn this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E):\nGET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10-28T10:26:35.000Z\n\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=).",
"location": "query",
"pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
"type": "string"
},
"maxResults": {
"description": "Maximum number of results to return. Maximum allowed is 1000",
"default": "1000",
"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.\nThe maxResults query string is optional.",
"format": "uint32",
"location": "query",
"maximum": "1000",
"minimum": "1",
"type": "integer"
},
"orgUnitID": {
"default": "",
"description": "the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s).",
"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.",
"location": "query",
"pattern": "(id:[a-z0-9]+)",
"type": "string"
},
"pageToken": {
"description": "Token to specify next page.",
"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": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
"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, classroom, cros, docs, gmail, gplus, device_management, meet, and sites.\nA parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2.\nNote: The API doesn't accept multiple values of a parameter.\nIf 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.\n\nAn example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.",
"location": "query",
"pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
"type": "string"
},
"userKey": {
"description": "Represents the profile id or the user email for which the data should be filtered.",
"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 G Suite profile ID or their primary email address.",
"location": "path",
"required": true,
"type": "string"
@@ -464,7 +560,7 @@
}
}
},
"revision": "20190521",
"revision": "20191014",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Activities": {
@@ -476,7 +572,7 @@
"type": "string"
},
"items": {
"description": "Each record in read response.",
"description": "Each activity record in the response.",
"items": {
"$ref": "Activity"
},
@@ -484,11 +580,11 @@
},
"kind": {
"default": "admin#reports#activities",
"description": "Kind of list response this is.",
"description": "The type of API resource. For an activity report, the value is reports#activities.",
"type": "string"
},
"nextPageToken": {
"description": "Token for retrieving the next page",
"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"
}
},
@@ -502,19 +598,19 @@
"description": "User doing the action.",
"properties": {
"callerType": {
"description": "User or OAuth 2LO request.",
"description": "The type of actor.",
"type": "string"
},
"email": {
"description": "Email address of the user.",
"description": "The primary email address of the actor. May be absent if there is no email address associated with the actor.",
"type": "string"
},
"key": {
"description": "For OAuth 2LO API requests, consumer_key of the requestor.",
"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"
},
"profileId": {
"description": "Obfuscated user id of the user.",
"description": "The unique G Suite profile ID of the actor. May be absent if the actor is not a G Suite user.",
"type": "string"
}
},
@@ -525,15 +621,15 @@
"type": "string"
},
"events": {
"description": "Activity events.",
"description": "Activity events in the report.",
"items": {
"properties": {
"name": {
"description": "Name of event.",
"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 G Suite service or feature which the API organizes into types of events.\nFor eventName request parameters in general: \n- If no eventName is given, the report returns all possible instances of an eventName. \n- When you request an eventName, the API's response returns all activities which contain that eventName. It is possible that the returned activities will have other eventName properties in addition to the one requested. \nFor 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.",
"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.",
"items": {
"properties": {
"boolValue": {
@@ -541,15 +637,15 @@
"type": "boolean"
},
"intValue": {
"description": "Integral value of the parameter.",
"description": "Integer value of the parameter.",
"format": "int64",
"type": "string"
},
"messageValue": {
"description": "Nested value of the parameter.",
"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}]}]",
"properties": {
"parameter": {
"description": "Looping to get parameter values.",
"description": "Parameter values",
"items": {
"$ref": "NestedParameter"
},
@@ -559,7 +655,7 @@
"type": "object"
},
"multiIntValue": {
"description": "Multi-int value of the parameter.",
"description": "Integer values of the parameter.",
"items": {
"format": "int64",
"type": "string"
@@ -567,11 +663,11 @@
"type": "array"
},
"multiMessageValue": {
"description": "Nested values of the parameter.",
"description": "List of messageValue objects.",
"items": {
"properties": {
"parameter": {
"description": "Parameter value.",
"description": "Parameter values",
"items": {
"$ref": "NestedParameter"
},
@@ -583,7 +679,7 @@
"type": "array"
},
"multiValue": {
"description": "Multi-string value of the parameter.",
"description": "String values of the parameter.",
"items": {
"type": "string"
},
@@ -603,7 +699,7 @@
"type": "array"
},
"type": {
"description": "Type of event.",
"description": "Type of event. The G Suite 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"
}
},
@@ -615,15 +711,15 @@
"description": "Unique identifier for each activity record.",
"properties": {
"applicationName": {
"description": "Application name to which the event belongs.",
"description": "Application name to which the event belongs. For possible values see the list of applications above in applicationName.",
"type": "string"
},
"customerId": {
"description": "Obfuscated customer ID of the source customer.",
"description": "The unique identifier for a G suite account.",
"type": "string"
},
"time": {
"description": "Time of occurrence of the activity.",
"description": "Time of occurrence of the activity. This is in UNIX epoch time in seconds.",
"format": "date-time",
"type": "string"
},
@@ -636,16 +732,16 @@
"type": "object"
},
"ipAddress": {
"description": "IP Address of the user doing the action.",
"description": "IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into G Suite 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"
},
"kind": {
"default": "admin#reports#activity",
"description": "Kind of resource this is.",
"description": "The type of API resource. For an activity report, the value is audit#activity.",
"type": "string"
},
"ownerDomain": {
"description": "Domain of source customer.",
"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"
}
},
@@ -713,7 +809,7 @@
"type": "boolean"
},
"intValue": {
"description": "Integral value of the parameter.",
"description": "Integer value of the parameter.",
"format": "int64",
"type": "string"
},
@@ -725,7 +821,7 @@
"type": "array"
},
"multiIntValue": {
"description": "Multiple integral values of the parameter.",
"description": "Multiple integer values of the parameter.",
"items": {
"format": "int64",
"type": "string"
@@ -755,7 +851,7 @@
"id": "UsageReport",
"properties": {
"date": {
"description": "The date to which the record belongs.",
"description": "The date of the report request.",
"readOnly": true,
"type": "string"
},
@@ -763,7 +859,7 @@
"description": "Information about the type of the item.",
"properties": {
"customerId": {
"description": "Obfuscated customer id for the record.",
"description": "The unique identifier of the customer's account.",
"readOnly": true,
"type": "string"
},
@@ -773,17 +869,17 @@
"type": "string"
},
"profileId": {
"description": "Obfuscated user id for the record.",
"description": "The user's immutable G Suite profile identifier.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The type of item, can be customer, user, or entity (aka. object).",
"description": "The type of item. The value is customer.",
"readOnly": true,
"type": "string"
},
"userEmail": {
"description": "user's email. Only relevant if entity.type = \"USER\"",
"description": "The user's email address. Only relevant if entity.type = \"USER\"",
"readOnly": true,
"type": "string"
}
@@ -797,11 +893,11 @@
},
"kind": {
"default": "admin#reports#usageReport",
"description": "The kind of object.",
"description": "The type of API resource. For a usage report, the value is admin#reports#usageReport.",
"type": "string"
},
"parameters": {
"description": "Parameter value pairs for various applications.",
"description": "Parameter value pairs for various applications. For the Customers usage report parameters and values, see the customer usage parameters reference.",
"items": {
"properties": {
"boolValue": {
@@ -810,13 +906,13 @@
"type": "boolean"
},
"datetimeValue": {
"description": "RFC 3339 formatted value of the parameter.",
"description": "The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"intValue": {
"description": "Integral value of the parameter.",
"description": "Integer value of the parameter.",
"format": "int64",
"readOnly": true,
"type": "string"
@@ -833,7 +929,6 @@
"type": "array"
},
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"stringValue": {
@@ -851,7 +946,6 @@
"type": "object"
},
"UsageReports": {
"description": "JSON template for a collection of usage reports.",
"id": "UsageReports",
"properties": {
"etag": {
@@ -860,11 +954,11 @@
},
"kind": {
"default": "admin#reports#usageReports",
"description": "The kind of object.",
"description": "The type of API resource. For a usage report, the value is admin#reports#usageReports.",
"type": "string"
},
"nextPageToken": {
"description": "Token for retrieving the next page",
"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"
},
"usageReports": {
@@ -875,15 +969,15 @@
"type": "array"
},
"warnings": {
"description": "Warnings if any.",
"description": "Warnings, if any.",
"items": {
"properties": {
"code": {
"description": "Machine readable code / warning type.",
"description": "Machine readable code or warning type. The warning code value is 200.",
"type": "string"
},
"data": {
"description": "Key-Value pairs to give detailed information on the warning.",
"description": "Key-value pairs to give detailed information on the warning.",
"items": {
"properties": {
"key": {
@@ -900,7 +994,7 @@
"type": "array"
},
"message": {
"description": "Human readable message for the warning.",
"description": "The human readable messages for a warning are: \n- Data is not available warning - Sorry, data for date yyyy-mm-dd for application \"application name\" is not available. \n- 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"
}
},